home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir43 / mlrpri30.zip / PRIVATE.TXT < prev    next >
Text File  |  1994-04-20  |  32KB  |  620 lines

  1.  
  2.                               My Little Realm Enterprises
  3.  
  4.                                -  Private Library 3.0  -
  5.  
  6.                                    Shareware Version
  7.           ____________________________________________________________________
  8.           
  9.                                         Important
  10.           ____________________________________________________________________
  11.  
  12.           Private Library is protected by copyright.  It is not freeware, and
  13.           it is not in the public domain.
  14.  
  15.           This is the Shareware (evaluation) version of My Little Realm's 
  16.           Private Library.  It is a full-featured, fully functional program.
  17.           You are welcome to try it on your computer to ensure that it 
  18.           functions on your system as it should, and that it meets your 
  19.           individual needs.
  20.  
  21.           If after 30 days you decide to keep using Private Library, you must
  22.           pay for the program.  To print an order form, press <$> in the 
  23.           Options Window or print the text file REGISTER.TXT.
  24.  
  25.           Bonus!  Get one MLR stand-alone program free with every order.  
  26.           Read DESCRIBE.TXT for details.  This offer expires 12/31/94.
  27.  
  28.           My Little Realm Enterprises stands behind all of its products with
  29.           a 30-day money back guarantee.
  30.  
  31.           Thank you for trying Private Library and Shareware!
  32.           ______________________________________________________________________
  33.                                                                          
  34.  
  35.  
  36.  
  37.  
  38.                              
  39.  
  40.                               My Little Realm Enterprises
  41.  
  42.  
  43.                                -  Private Library 3.0  -
  44.  
  45.  
  46.  
  47.                                        Contents               
  48.  
  49.                General Information......................................1
  50.                     Introduction........................................1
  51.                Overview.................................................1
  52.                     Interface...........................................1
  53.                     Quickeys............................................1
  54.                     Extended Processing Options.........................2
  55.                Getting Started..........................................2
  56.                     Changing the Quickeys...............................2
  57.                     Creating Records....................................2
  58.                Program Information......................................3
  59.                The Options Window.......................................3
  60.                Option # 1, Adding New Records...........................3
  61.                     Field Definitions...................................3
  62.                          The Default Quickey Categories.................4
  63.                          Hiding the Quickeys............................4
  64.                          Dewey Decimal Codes............................5
  65.                Option # 2, Viewing Your Records.........................5
  66.                Option # 3, Changing the Contents of a Record............5
  67.                Option # 4, Deleting Records.............................6
  68.                Option # 5, Printing records.............................6
  69.                Option # 6, Sorting records..............................6
  70.                Option # 7, Searching Records............................7
  71.                     Searching on the Title and Author Fields............7
  72.                     Searching on the Category Field.....................8
  73.                Extended Processing Options..............................8
  74.                     <\> Change Quickeys Categories......................8
  75.                     <|> Hide/show the Quickeys..........................9
  76.                     <#> Switch Between Color and B/W Modes.............10
  77.                     <?> Display EPO Symbols and Definitions............10
  78.                                                                             
  79.           Private Library                                              Page 1
  80.  
  81.           ____________________________________________________________________
  82.  
  83.                                  General Information
  84.           ____________________________________________________________________
  85.  
  86.                                     Introduction
  87.  
  88.           Private Library allows you to keep track of your privately owned 
  89.           volumes (including books, records, tapes, cd's and videos).  With 
  90.           Private Library you can perform the standard view, edit, print and 
  91.           sort functions.  Its most powerful feature, however, is its search 
  92.           function.
  93.  
  94.           For starters, if you'd like to see which books you have of a 
  95.           certain author, enter that author's name in the Search function, 
  96.           and you'll get every work in your library that has that name in the
  97.           Author field.
  98.  
  99.           If you're a Sci Fi fanatic and you'd like to see what you have on
  100.           robots, tell the Search function to look for "robot" in the Title
  101.           field.
  102.  
  103.           You can also search on the Category field to see what you have in
  104.           any of your current Quickey categories.
  105.  
  106.           Would you like a way to keep your books separate from a roommate's?
  107.           Use the Category field to identify ownership.  Then you can search 
  108.           on the Category field to see which works (or items) belong to whom.
  109.           It can help keep the peace.
  110.  
  111.           ____________________________________________________________________
  112.  
  113.                                       Overview
  114.  
  115.           Interface.
  116.  
  117.           Private Library's screen consists of two types of windows:  a 
  118.           Working Window and an Options Window.
  119.  
  120.           If you are using a color monitor the Working Window is red and the
  121.           Options Window is blue.
  122.  
  123.           You select processes (like adding, updating, or deleting records)
  124.           in the Options Window.  You create and view your records in the 
  125.           Working Window.
  126.  
  127.                              ----------------------------
  128.           
  129.           Quickeys.
  130.  
  131.           The Quickeys give you single key access to the categories you have
  132.           defined in your Quickey file.  Initially these are very general
  133.           categories like fiction, non-fiction, etc.  You can define them as
  134.           you like using the <\> Change Quickeys EPO.                 
  135.           Private Library                                              Page 2
  136.  
  137.           Extended Processing Options.
  138.           
  139.           Several processing tasks, called extended processing options or 
  140.           EPO's, are not listed in the Options Windows, because they are 
  141.           functions that only occasionally need to be performed.  EPO's are
  142.           used to "extend" a program's power and functionality.  One EPO you
  143.           should be aware of initially is the Change Quickeys function, which
  144.           allows you to create and change your Reader and Library Quickeys.  
  145.           You invoke it by pressing the backslash in the Options Window.
  146.  
  147.           To find out what EPO commands are employed by Private Library, 
  148.           enter <?> (the question mark) in the Options Window.  See "Extended
  149.           Processing Options", page 8, for a full description of all the EPO 
  150.           commands and their definitions.
  151.  
  152.           ____________________________________________________________________
  153.  
  154.                                    Getting Started
  155.  
  156.           Changing the Quickeys.
  157.           The Quickeys in Private Library let you categorize your privately 
  158.           owned works just the way you want.  This can be by general 
  159.           categories like fiction, non-fiction, etc., or it could be by 
  160.           owner.  The default categories are defined on page 4.
  161.  
  162.           If you'd like to see the default Quickeys of Private Library, 
  163.           enter the backslash key in the Options Window.  This invokes the 
  164.           Change Quickeys function, and displays the following query in the 
  165.           Options Window:
  166.  
  167.                   _______________________________________________
  168.                  |                                               |
  169.                  |    Change which Quickey?  __                  |
  170.                  |           ________________________________    |
  171.                  |          |                                |   |
  172.                  |          |   1  fic    3  l/d    5  a/t   |   |
  173.                  |          |   2  n/f    4  v/t    6  c/d   |   |
  174.                  |          |________________________________|   |
  175.                  |                                               |
  176.                  |_______________________________________________|
  177.  
  178.  
  179.           If you don't want to change the Quickeys at this time, simply press
  180.           <esc> when you're finished studying them.  If you'd like to make
  181.           changes, enter the number of the Quickey category you want to 
  182.           change and type in the new definition.  Read the section entitled
  183.           "Extended Processing Options" on page 8 for more details.
  184.  
  185.           Creating Records.
  186.           The most common items recorded in the Private Library program are
  187.           books.  They're easy to enter since there are only three fields to
  188.           deal with:  the Title field, the Author field, and the Category
  189.           field.  Example:
  190.  
  191.                    Title                Author                    Cat.
  192.  
  193.                   Lincoln            Vidal, Gore                  fic    
  194.           Private Library                                              Page 3
  195.  
  196.           Other personal collectibles that can be recorded are videos.  Enter 
  197.           the title, as you would a book, and in the Author field, enter the 
  198.           time and whether the item is black & white or color.  Finally, 
  199.           enter the Quickey (4 from the above example), v/t, for video tape.
  200.           Example:
  201.  
  202.                    Title                Author                    Cat.
  203.  
  204.                 Casablanca            103 min.   black/white      v/t
  205.  
  206.           After you've entered all of your video tapes, you can obtain a
  207.           printed listing (to keep by the television) by invoking the Search
  208.           function and searching the Category field for v/t.  If you want the
  209.           listing in alphabetic order, sort your records first.
  210.  
  211.           ____________________________________________________________________
  212.  
  213.                                  Program Information
  214.           ____________________________________________________________________
  215.  
  216.           Options Window.
  217.           There are seven choices in the Options Window.
  218.  
  219.                        ________________________________________
  220.                       |                                        |
  221.                       |   1  Add      2  View     3  Change    |
  222.                       |   4  Delete   5  Print    6  Sort      |
  223.                       |               7  Search                |
  224.                       |   ----------------------------------   |
  225.                       |             Choice __                  |
  226.                       |________________________________________|
  227.  
  228.           
  229.           There are several extended processing options available from the 
  230.           Options Window.  They are detailed on page 8.
  231.  
  232.           ____________________________________________________________________
  233.  
  234.           Option # 1, Adding New Records.
  235.  
  236.           The Add function in this program has three entries.  To back up 
  237.           through the fields in this function, press the up arrow.  To 
  238.           advance through the fields, press the down arrow.
  239.  
  240.                     Note:  You cannot use the down arrow to go 
  241.                     from the Title field to the Author field unless 
  242.                     the Title field has something in it.
  243.  
  244.                                 ~ Field Definitions ~
  245.  
  246.           - Title field (38, required).
  247.  
  248.           Leading articles and prepositions should be put at the end of the 
  249.           title.  For example, the title of the novel "The Agony and the 
  250.           Ecstasy" by Irving Stone would be entered as:
  251.  
  252.                                  Agony and the Ecstasy, The          
  253.           Private Library                                              Page 4
  254.  
  255.           - Author field (33, optional).
  256.  
  257.           An author's name should be entered with the last name first:
  258.  
  259.                                  Stone, Irving
  260.  
  261.           The major reason for entering titles and names in this manner is 
  262.           that it facilitates record sorting should you request that option
  263.           (# 6 in the Options Window).  
  264.  
  265.                                    ____________________
  266.  
  267.           - Category field (3, optional).
  268.  
  269.           Private Library displays its built-in Quickeys when it is time to 
  270.           enter the category field.
  271.  
  272.           The Default Quickey Categories.
  273.                                 
  274.                         Quickey     Category       Definition      
  275.                         
  276.                            1           fic          fiction
  277.                            2           n/f          non-fiction
  278.                            3           l/d          laser disc
  279.                            4           v/t          video tape
  280.                            5           a/t          audio tape
  281.                            6           c/d          compact disc
  282.  
  283.  
  284.           Hiding the Quickeys.
  285.           Private Library only accepts a Quickey in this field.  You may, on
  286.           occasion, desire to enter numbers in the category field like the
  287.           Dewey Decimal numbers.  Rather than redefine your Category Quickey
  288.           list, you can simply turn off the Quickeys.  When the Quickeys are 
  289.           hidden, you can enter anything you like in the Category field.
  290.  
  291.           In other words, if the Quickeys are turned on, you are only able to 
  292.           enter a category from the Quickey list.  If you want to enter 
  293.           category information that is not on the Quickey list, turn off 
  294.           (that is, hide) the Quickeys using the <|> EPO.  You can then enter
  295.           any three character string you wish.
  296.  
  297.           To hide the Quickeys, enter <|>, the pipe symbol on your keyboard, 
  298.           in the Options Window.  Private Library tells you that your
  299.           Quickeys are not hidden and then asks if you want to hide them.
  300.           Respond <Y>, yes.  If you change your mind, press <esc> or <N>.
  301.           See "Extended Processing Options" on page 8 for more details.
  302.  
  303.           If you should delete any of the Quickey categories, leaving the 
  304.           category blank, Private Library does not let you enter that Quickey
  305.           in the Add or Change functions if the Quickeys are active.
  306.  
  307.           You can change any of the Quickeys that come with Private Library 
  308.           by using the backslash EPO.  If you plan to use the Dewey Decimal 
  309.           System frequently to categorize your works, change the Quickeys to 
  310.           the DDS codes you'll be using most often.                 
  311.           Private Library                                              Page 5
  312.  
  313.                       --  The Dewey Decimal System Codes  --
  314.  
  315.                       DDS Code    Definition                
  316.  
  317.                         000       General titles (journalism, 
  318.                                       bibliographies, etc.)
  319.                         100       Philosophy
  320.                         200       Religion
  321.                         300       Social Studies
  322.                         400       Languages
  323.                         500       Pure Sciences
  324.                         600       Technology (Applied Sciences)
  325.                         700       Arts
  326.                         800       Literature
  327.                         900       Geography and History
  328.  
  329.           You can also set up your Quickeys as the initials of the realm 
  330.           members so that you can identify the owner of each of the works you 
  331.           enter in this program.  To use the Change Quickey EPO, refer to the
  332.           section entitled "Extended Processing Options" on page 8.
  333.  
  334.           Note:  You cannot change the Quickeys if they are hidden.  The only
  335.           exception to this rule is if there are no Quickeys (i.e., you 
  336.           deleted all of them previously), in which case Private Library 
  337.           allows you to create a new Quickey list, but then your new list is
  338.           considered hidden until you expressly state otherwise.
  339.  
  340.           If you leave Private Library with the Quickeys turned off, Private 
  341.           Library remembers that the next time you run the program.  To show 
  342.           the Quickeys (i.e., turn them on), press <|> in the Options Window 
  343.           and reply <Y>, yes, to Private Library's query.
  344.           ____________________________________________________________________
  345.  
  346.           Option # 2, Viewing Your Records.
  347.  
  348.           Private Library asks you which record number you wish to see.  You 
  349.           do not have to enter a record number.  You can use the scrolling 
  350.           keys to browse through your records.
  351.  
  352.           Should you wish to focus on one particular entry, give the record 
  353.           number to Private Library and that record's information is
  354.           highlighted for you.
  355.  
  356.           If you have a large number of records and you're trying to find a
  357.           specific title or author, use the Search function, Option # 7, 
  358.           described on page 7.
  359.  
  360.           To exit the View function and return to the Options Window, press 
  361.           <enter> (without entering a record number) or press <esc>.
  362.           ____________________________________________________________________
  363.  
  364.           Option # 3, Changing the Contents of a Record.
  365.  
  366.           To change the contents of a record, you must first find the specific
  367.           record you wish to modify.  Enter the record number, and Private 
  368.           Library highlights the record you have selected to change.   
  369.           Private Library                                              Page 6
  370.  
  371.           If you select one of the fields to modify and then change your mind,
  372.           press <esc> while on the input line (before you press <enter>), and
  373.           Private Library reinstates the original entry.  Remember, the Title
  374.           field must have an entry.  You cannot leave it blank.
  375.  
  376.           To exit the Change function and return to the Options Window, press 
  377.           <enter> (without entering a record number) or press <esc>.
  378.  
  379.           Don't forget that if you want to change the Category field in a 
  380.           record and you want to use the Quickeys, they cannot be hidden.
  381.           ____________________________________________________________________
  382.  
  383.           Option # 4, Deleting Records.
  384.  
  385.           Enter the record number.  Private Library highlights the entry and 
  386.           asks you if you are sure.  You must respond <Y> for yes if you 
  387.           wish to effect the delete.  Press <N>, for no, or the <esc> key to
  388.           cancel the delete request.  Be sure the highlighted record is the 
  389.           one that you wish to delete.
  390.  
  391.           To exit the Delete function and return to the Options Window, press 
  392.           <enter> (without entering a record number) or press <esc>.
  393.  
  394.           ____________________________________________________________________
  395.  
  396.           Option # 5, Printing Records.
  397.  
  398.           The Print function prints a listing of all of your records as they 
  399.           appear at the time you request the printout.
  400.  
  401.           Thus, if you want the records printed in sorted order, you must 
  402.           select option 6 first, and direct Private Library to sort the array
  403.           containing your records and on which field it is to perform the 
  404.           sort.
  405.  
  406.           The Sort function then brings up the View procedure and shows you 
  407.           the sorted file.  If all is in order, press <esc> to return to the 
  408.           Options Window and select 5 to print out the results of the sort.
  409.  
  410.           You can abort the printout at any time during the printing process
  411.           by pressing <esc>.
  412.           ____________________________________________________________________
  413.  
  414.           Option # 6, Sorting Records.
  415.  
  416.           Option 6 lets you sort your records by title, author, or category.
  417.           After the sorting is finished, the View function is automatically 
  418.           invoked and your sorted records displayed.
  419.  
  420.           Press <esc> to return to the Options Window.
  421.  
  422.           Note:  Private Library stores your records on disk in the same
  423.           order shown in the Viewing Window.  Thus, if you've sorted your
  424.           records by title, they'll be stored that way, and the next time 
  425.           you run Private Library, that's the order in which they'll be 
  426.           displayed.                                                
  427.           Private Library                                              Page 7
  428.  
  429.           ____________________________________________________________________
  430.  
  431.           Option # 7, Searching Records.
  432.  
  433.           The Search function allows you to find all of the records with a
  434.           specific character string, called a keyword, in a given field.  It
  435.           gives you a special look at your library, and it can help you find
  436.           a specific book (or record or video) in seconds.
  437.  
  438.           You enter keywords without quotes.  You may use the backslash as a 
  439.           special delimiter, described below, to force the Search function to 
  440.           look for external spaces.
  441.  
  442.           Searching on the Title and Author Fields.
  443.           If you want the Search function to display all of the books with 
  444.           the word "computer" in the title, select the Title field from its 
  445.           sub-menu and enter the keyword "computer" (without the quotes).  In
  446.           short order, the Search function would display all of the volumes 
  447.           it found with the word "computer" in the title.
  448.  
  449.           If there is more than a screenful of records, the Search function 
  450.           tells you to use the scrolling keys to peruse the listing.  The 
  451.           scrolling keys are the directional keys, <ctrl> + <home>, 
  452.           <ctrl> + <end>, <pageup>, and <pagedown>.
  453.  
  454.           You can also print the Search function listing by pressing <P>.
  455.  
  456.           You must be as precise as possible if you are looking for a 
  457.           specific record.  That is to say, if you are looking for a 
  458.           particular author, you must give the Search function the entire 
  459.           name of said author or it might retrieve a number of records whose 
  460.           authors have the same keyword in their names.
  461.           
  462.           As an example, if you were searching for all of the volumes written
  463.           by "Smith, Alice", you could enter "Smith" for a keyword, but you 
  464.           would also get all of the records with any other Smith's you had in
  465.           the Author field.  You would have to enter "Smith, Alice" to have 
  466.           the Search function display only those works by that author.  The 
  467.           same is true for the Title and Category fields.
  468.  
  469.           When you can't recall the spelling of an author's name or the title 
  470.           of a book (or whatever it is you've cataloged), enter just enough 
  471.           of the keyword to have the Search function weed out the bulk of the
  472.           unwanted records.
  473.           
  474.           For instance, if you're trying to find a book title but all you can
  475.           remember of its author's name is that it contains the syllable 
  476.           "Long", just enter that portion.  The Search function displays 
  477.           the records it finds with that syllable in the Author field, like 
  478.           "Longman" or "Longfellow" or "Longacre", but the number of records 
  479.           has been reduced considerably, and you'll be able to find the
  480.           record you're looking for much more quickly and easily.
  481.  
  482.           The Search function strips off the external blanks that you enter 
  483.           around a keyword when it performs the search on either the Title 
  484.           Private Library                                              Page 8
  485.  
  486.           field or the Author field.  "   ABC   ", for example, is reduced 
  487.           to "ABC".  You can force the Search function to search for 
  488.           precisely what you enter by delimiting your keyword with 
  489.           backslashes.  To make the Search function look for a keyword like 
  490.           "   ABC   " (with its concomitant external spaces), you can enter:
  491.  
  492.                                      \   ABC   \
  493.  
  494.           Let's assume you have the following titles in your file:
  495.  
  496.                               Longbows of the 18th Century
  497.                               Long John Silver
  498.                               Longacre's Mysteries
  499.  
  500.           If you simply entered "Long" at the keyword prompt, the Search
  501.           function would show you all three of those records, even if you 
  502.           entered the keyword as "Long ".  To winnow it down, you can force 
  503.           the Search function to search for "Long " (with a trailing space) 
  504.           by entering \Long \ and get only the second title, "Long John 
  505.           Silver".
  506.  
  507.           When using the backslash as a delimiter, however, you must ensure
  508.           that you begin and end your keyword with backslashes.  If, instead, 
  509.           you entered:
  510.                                    \ long\acre                          
  511.  
  512.           the Search function assumes that it is supposed to look for the 
  513.           backslashes since one is embedded, and it searches for exactly what
  514.           you entered ... including the backslashes.
  515.  
  516.                     Notes:  Private Library's Search function 
  517.                     is not case sensitive, so "ABC" is the 
  518.                     same as "aBc", and so on.
  519.  
  520.           Searching on the Category Field.
  521.           When you search on the Category field, you must use the Quickeys
  522.           if they are active.  If they are inactive (hidden), you cannot use 
  523.           them, but you can enter any string found in the Quickey list.  You 
  524.           simply have to key it in manually.
  525.  
  526.           Keywords do not have their external spaces removed when searches 
  527.           are performed on the Category field.  So " d " (with a space on 
  528.           either side) is different from "d  " (with two trailing spaces), 
  529.           and so on.
  530.           ____________________________________________________________________
  531.  
  532.                                 Extended Processing Options
  533.  
  534.                EPO  Definition
  535.                          
  536.                <\>  Change Quickeys Categories.
  537.  
  538.                     The Quickeys categories can be up to three letters long, 
  539.                     and are used to describe the categories of your personal 
  540.                     volumes.  Private Library comes with six Quickey classi-
  541.                     fications that represent general purpose categories. 
  542.           Private Library                                              Page 9
  543.  
  544.                     Default Quickeys.
  545.                                  ________________________________    
  546.                                 |                                |   
  547.                                 |   1  fic    3  l/d    5  a/t   |   
  548.                                 |   2  n/f    4  v/t    6  c/d   |   
  549.                                 |________________________________|   
  550.  
  551.                                  Quickey    Code       Definition      
  552.  
  553.                                     1        fic       fiction
  554.                                     2        n/f       non-fiction
  555.                                     3        l/d       laser disc
  556.                                     4        v/t       video tape
  557.                                     5        a/t       audio tape
  558.                                     6        c/d       compact disc
  559.  
  560.                     You can, of course, change any you choose.  For example, 
  561.                     you could make one of your categories "Com" for comic 
  562.                     books or "BBC" for baseball cards.  You can even use
  563.                     the initials of the owners of the works you are 
  564.                     cataloging as a means of identifying ownership, should
  565.                     you wish to keep your works separate from your roommate's.
  566.  
  567.                     You do not need to use the Quickeys.  For example, while
  568.                     the Quickeys are active, you must either use a Quickey or
  569.                     press <enter> to leave the Category field blank.
  570.  
  571.                     If you want to be able to enter any random numbers or 
  572.                     letters in the Category field, use the <|> EPO, described
  573.                     below, to hide the Quickeys.  Then you can enter whatever
  574.                     you wish.
  575.  
  576.                     Note:  You cannot change the Quickeys if they are hidden.
  577.  
  578.                <|>  Hide/show the Quickeys.
  579.  
  580.                     The Quickeys are numbers one through six in the first 
  581.                     position of the category entry.  Enter <|> in the
  582.                     Options Window and Private Library tells you if your 
  583.                     Quickeys are hidden or not.  It then asks you if you 
  584.                     want to reverse the situation.
  585.  
  586.                     If the Quickeys are turned on, you must use them when
  587.                     you are entering data in the Category field.  If you 
  588.                     want to enter categories not found in your Quickey 
  589.                     list, you must either turn off the Quickeys or change 
  590.                     the current Quickeys.  If you turn off the Quickeys, 
  591.                     you can enter anything you wish in the three character 
  592.                     field.
  593.  
  594.                     You do no harm to your previously entered records by 
  595.                     turning the Quickeys on and off.
  596.  
  597.                                     - - - - - - - - -                  
  598.           Private Library                                             Page 10
  599.                <+>  Print a Listing of a Specific Category.
  600.  
  601.                     Note:  This EPO is no longer supported in Version 2.x.
  602.                     See the Search function, option <7> in the Options 
  603.                     Window, for this and many other new features found in
  604.                     Version 2.x and later.
  605.  
  606.                                     - - - - - - - - -
  607.  
  608.                <#>  Switch between color and B/W modes.
  609.  
  610.                                     - - - - - - - - -
  611.  
  612.                <?>  Display the EPO's used in this Program.
  613.  
  614.           ____________________________________________________________________
  615.  
  616.                                       +  The End  +
  617.           ____________________________________________________________________
  618.  
  619.           (c) Copyright 1991 - 1994 John L. Salisbury                 
  620.